/*
 * ------------------------------------------------------------------------
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * Created on Mar 17, 2013 by wiswedel
 */
package org.knime.base.node.preproc.domain.editnominal;

import java.util.Optional;
import java.util.Set;

import org.knime.core.data.DataCell;
import org.knime.core.data.DataColumnSpec;
import org.knime.core.data.DataTableSpec;
import org.knime.core.data.DataType;
import org.knime.core.data.StringValue;
import org.knime.core.data.def.StringCell;
import org.knime.core.node.InvalidSettingsException;
import org.knime.core.node.NodeDialogPane;
import org.knime.core.node.NodeSettingsRO;
import org.knime.core.node.NodeSettingsWO;
import org.knime.core.node.NotConfigurableException;
import org.knime.core.node.util.ColumnFilter;

/**
 * Dialog to node.
 *
 * @author Marcel Hanser
 */
public class EditNominalDomainNodeDialogPane extends NodeDialogPane {

    private final EditNominalDomainDialog m_editNominalDomainDialog;

    private static class NominalDomainTypeHandler implements EditNominalDomainDialog.TypeHandler {

        /**
         * {@inheritDoc}
         */
        @Override
        public DataType getClassType() {
            return StringCell.TYPE;
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public ColumnFilter getColumnFilter() {
            return new ColumnFilter() {
                @Override
                public boolean includeColumn(final DataColumnSpec name) {
                    return name.getType().isCompatible(StringValue.class);
                }

                @Override
                public String allFilteredMsg() {
                    return "";
                }
            };
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public Optional<Set<DataCell>> getPossibleValues(final DataColumnSpec spec) {
            return Optional.ofNullable(spec.getDomain().getValues());
        }
    }

    /**
     *
     */
    public EditNominalDomainNodeDialogPane() {
        m_editNominalDomainDialog = new EditNominalDomainDialog(new NominalDomainTypeHandler(), false);
        addTab("Edit Domain Values", m_editNominalDomainDialog.getPanel());
    }

    /**
     * Saving and restoring.
     **/
    /**
     * {@inheritDoc}
     */
    @Override
    protected void saveSettingsTo(final NodeSettingsWO settings) throws InvalidSettingsException {
        m_editNominalDomainDialog.save(settings);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void loadSettingsFrom(final NodeSettingsRO settings, final DataTableSpec[] specs)
        throws NotConfigurableException {
        m_editNominalDomainDialog.load(settings, specs[0]);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void onClose() {
        m_editNominalDomainDialog.close();
    }

}
